Skip to main content

replaceText

Type

function

Summary

Searches for a regex pattern and replaces the portions that match it.

Syntax

replaceText(<stringToChange>, <matchExpression>, <replacementString>)

Description

Use the replaceText function to search for and replace text that matches a particular pattern.

The replaceText function replaces all the occurrences of the matchExpression with the replacementString. If more than one matching substring is found, the replaceText function replaces all of them.

The replaceText function is not as fast as the replace command, but is more flexible because you can search for any text that matches a regex pattern.

The stringToChange and matchExpression are always case-sensitive, regardless of the setting of the caseSensitive property. (If you need to make a case-insensitive comparison, use "(?i)" at the start of the matchExpression to make the match case-insensitive.)

Parameters

NameTypeDescription

stringToChange

string

A container reference or literal value.

matchExpression

Any expression that evaluates to a regex pattern

replacementString

string

A container reference or literal value.

Examples

put replaceText("malformed","mal","well") -- returns "wellformed"
-- change return-delimited text to comma-delimited
put replaceText(field "Stats",return,comma) into field "Stats"
put replaceText("colour or color","colou?r","culler")
-- returns "culler or culler"
-- escape RegEx metacharacter using backslash
put replaceText ( "ABC|DEV" , "\|" , CR )

command: replace, filter

glossary: command, regex pattern, property

keyword: string

property: caseSensitive

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile

Thank you for your feedback!

Was this page helpful?